Introduction

The Clinical Frontend Framework (CFF) Libraries provide a robust set of tools and components for building clinical web applications. These libraries are designed to streamline development, enhance maintainability, and ensure consistency across clinical projects.

Overview

The CFF Libraries include modules for visualization, editing, and interaction within clinical applications. They are built to integrate seamlessly with the broader clinical ecosystem, providing developers with the flexibility and power needed to create high-quality user experiences.

Resources

• Demos and Documentation: Explore live demos and detailed documentation in Storybook.
• Project Details: Learn more about the project on the Confluence page.

Contributing

The CFF Libraries follow an Inner-source model, encouraging collaboration and contributions from the community.

• Governance: Refer to the GOVERNANCE.md for details on the governance model.
• Contributing Guide: Check the CONTRIBUTING.md for contribution guidelines.
• Work Tracking: Open tickets and ongoing work can be accessed on the Azure DevOps (ADO) board.

Getting Started

Prerequisites

1. Node.js: Ensure Node.js 20 is installed (use .nvmrc for version management).
2. Yarn: Install Yarn 4 (berry) as the package manager.
3. Git Configuration: Set up Git with proper line endings and commit signing.

Installation

1. Clone the repository and navigate to the project folder.
2. Run the initYarnrc.sh script to configure authentication for the Azure Artifacts registry.
3. Install dependencies using yarn.

Development

• Start the development server with yarn dev to launch Storybook for component development.
• Use manypkg check to ensure dependency consistency across packages.

Versioning

The CFF Libraries use beachball for versioning. Changes are tracked via change files, and CI automates version bumps and package publishing.

• Creating Change Files: Use yarn change to generate change logs for modified packages.
• Promoting Releases: Promote beta releases to stable using the release pipeline.

The CFF Libraries aim to empower developers with a reliable and efficient framework for clinical application development. Dive into the resources and start building today!